<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Spelling Engine</title>
<style type="text/css">@import url("file:/home/moovida/rcpdevelopment/eclipse/configuration/org.eclipse.osgi/bundles/488/1/.cp/book.css");</style>
<style type="text/css">@import url("file:/home/moovida/rcpdevelopment/eclipse/configuration/org.eclipse.osgi/bundles/505/1/.cp/schema.css");</style>
</HEAD>
<BODY>
<H1 style="text-align:center">Spelling Engine</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.ui.workbench.texteditor.spellingEngine<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>3.1
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>Allows contributors to add spelling engines.<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.engine">engine</a>+)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>point</b> - a fully qualified identifier of the target extension point</li>
<li><b>id</b> - an optional identifier of the extension instance</li>
<li><b>name</b> - an optional name of the extension instance</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.engine">engine</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST engine</p>
<p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">label&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">default&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(true | false) </p><p class="code SchemaDtdAttlist">preferencesClass&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
The definition of a spelling engine.</p>
<br>
<ul class="ConfigMarkupAttlistDesc">
<li><b>class</b> - the class of the engine, which must implement <code>org.eclipse.ui.texteditor.spelling.ISpellingEngine</code></li>
<li><b>label</b> - the display label for the engine, which will show up in the menu that allows the user to choose the spelling engine</li>
<li><b>id</b> - a string uniquely identifying this engine</li>
<li><b>default</b> - if this flag is set to <code>true</code>, this spelling engine will be installed per default. If multiple engines are installed with the flag set are encountered, the first one is taken.</li>
<li><b>preferencesClass</b> - an implementation of <code>org.eclipse.ui.texteditor.spelling.ISpellingPreferenceBlock</code></li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>The following is an example of a spelling engine definition.

<p>
<pre class="Example"><span class="code SchemaTag">
  &lt;extension point=</span><span class="code SchemaCstring">&quot;org.eclipse.ui.workbench.texteditor.spellingEngine&quot;</span><span class="code SchemaTag">&gt;
    &lt;engine
        default=</span><span class="code SchemaCstring">&quot;true&quot;</span><span class="code SchemaTag">
        label=</span><span class="code SchemaCstring">&quot;%defaultSpellingEngine.label&quot;</span><span class="code SchemaTag">
        class=</span><span class="code SchemaCstring">&quot;org.eclipse.jdt.internal.ui.text.spelling.DefaultSpellingEngine&quot;</span><span class="code SchemaTag">
        id=</span><span class="code SchemaCstring">&quot;org.eclipse.jdt.internal.ui.text.spelling.DefaultSpellingEngine&quot;</span><span class="code SchemaTag">&gt;
    &lt;/engine&gt;
  &lt;/extension&gt;
</span></pre>
</p>
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Supplied Implementation: </h6>The <code>org.eclipse.jdt.ui</code> plugin contributes <code>DefaultSpellingEngine</code>. See its implementation as an example.
<p></p>

<br>
<p class="note SchemaCopyright">
Copyright (c) 2001, 2005 IBM Corporation and others.<br>
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>

</p>
</BODY>
</HTML>
